Default to Windows attribution when the os value is not "osx" (#204)

Author: willdurand

stubservice/stubhandlers/stubhandler_test.go

@@ -332,10 +332,22 @@ func TestDirectFull(t *testing.T) {
 	for _, params := range []struct {
 		AttributionCode string
 		ExpectedCode    string
+		OS              string
 	}{
 		{
 			AttributionCode: `campaign=%28not+set%29&content=%28not+set%29&medium=organic&source=www.google.com`,
 			ExpectedCode:    `campaign%3D%2528not%2Bset%2529%26content%3D%2528not%2Bset%2529%26dltoken%3D[\w\d-]+%26medium%3Dorganic%26source%3Dwww.google.com`,
+			OS:              "win",
+		},
+		{
+			AttributionCode: `campaign=%28not+set%29&content=%28not+set%29&medium=organic&source=www.google.com`,
+			ExpectedCode:    `campaign%3D%2528not%2Bset%2529%26content%3D%2528not%2Bset%2529%26dltoken%3D[\w\d-]+%26medium%3Dorganic%26source%3Dwww.google.com`,
+			OS:              "win64",
+		},
+		{
+			AttributionCode: `campaign=%28not+set%29&content=%28not+set%29&medium=organic&source=www.google.com`,
+			ExpectedCode:    `campaign%3D%2528not%2Bset%2529%26content%3D%2528not%2Bset%2529%26dltoken%3D[\w\d-]+%26medium%3Dorganic%26source%3Dwww.google.com`,
+			OS:              "win64-aarch64",
 		},
 	} {
 		testHook.Reset()
@@ -346,7 +358,11 @@ func TestDirectFull(t *testing.T) {
 		base64Code := base64.URLEncoding.WithPadding('.').EncodeToString([]byte(params.AttributionCode))
 		req := httptest.NewRequest(
 			"GET",
-			`http://test/?product=firefox-stub&os=win&lang=en-US&attribution_code=`+url.QueryEscape(base64Code),
+			fmt.Sprintf(
+				"http://test/?product=firefox-stub&os=%s&lang=en-US&attribution_code=%s",
+				params.OS,
+				url.QueryEscape(base64Code),
+			),
 			nil,
 		)
 		svc.ServeHTTP(recorder, req)
@@ -467,4 +483,27 @@ func TestStubServiceErrorCases(t *testing.T) {
 			t.Errorf("service did not return bouncer redirect status: %d loc: %s", code, location)
 		}
 	})
+
+	t.Run("unsupported OS", func(t *testing.T) {
+		base64Code := base64.URLEncoding.WithPadding('.').EncodeToString([]byte("campaign=test"))
+
+		for _, params := range []struct{ OS string }{
+			{OS: "linux"},
+			{OS: "linux64"},
+		} {
+			expectedLocation := fmt.Sprintf("https://download.mozilla.org/?lang=en-US&os=%s&product=firefox-latest-ssl", params.OS)
+
+			recorder := fetchURL(fmt.Sprintf(
+				"http://test/?product=firefox-latest-ssl&os=%s&lang=en-US&attribution_code=%s",
+				params.OS,
+				url.QueryEscape(base64Code),
+			))
+			code := recorder.Code
+			location := recorder.HeaderMap.Get("Location")
+
+			if code != 302 || location != expectedLocation {
+				t.Errorf("service did not return bouncer redirect status: %d loc: %s (os=%s)", code, location, params.OS)
+			}
+		}
+	})
 }

stubservice/stubhandlers/stubservice.go

@@ -21,7 +21,7 @@ func NewStubService(stubHandler StubHandler, validator *attributioncode.Validato
 	return &stubService{
 		Handler:                  stubHandler,
 		AttributionCodeValidator: validator,
-		BouncerBaseURL: bouncerBaseURL,
+		BouncerBaseURL:           bouncerBaseURL,
 	}
 }
 

stubservice/stubhandlers/utils.go

@@ -104,11 +104,6 @@ func modifyStub(st *stub, attributionCode string, os string) (res *stub, err err
 	body := st.body
 	if attributionCode != "" {
 		switch os {
-		case "win":
-			// Windows exe attribution
-			if body, err = stubmodify.WriteAttributionCode(st.body, []byte(attributionCode)); err != nil {
-				return nil, &modifyStubError{err, attributionCode}
-			}
 		case "osx":
 			// Mac DMG attribution
 			dmgbody, err := dmglib.ParseDMG(bytes.NewReader(body))
@@ -122,15 +117,22 @@ func modifyStub(st *stub, attributionCode string, os string) (res *stub, err err
 			}
 			body = dmgbody.Data
 		default:
-			// Unknown OS
-			return nil, &modifyStubError{err, attributionCode}
+			// Windows exe attribution is the default since only macOS and Windows builds are attributable,
+			// and macOS only has one "os" identifier.
+			//
+			// Note also that the bouncer service determines which build should be attributed.
+			if body, err = stubmodify.WriteAttributionCode(st.body, []byte(attributionCode)); err != nil {
+				return nil, &modifyStubError{err, attributionCode}
+			}
 		}
 	}
+
 	logrus.WithFields(logrus.Fields{
 		"original_filename":    st.filename,
 		"original_stub_sha256": fmt.Sprintf("%X", sha256.Sum256(st.body)),
 		"modified_stub_sha256": fmt.Sprintf("%X", sha256.Sum256(body)),
-		"attribution_code":     attributionCode}).Info("Modified stub")
+		"attribution_code":     attributionCode,
+	}).Info("Modified stub")
 
 	return &stub{
 		body:        body,