-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Authenticate endpoints and validate user state_code in metrics reques…
…ts (#546) * Guard metric api behind auth * verify matching state code when retrieving metrics when auth is enabled, don't verify if auth is disabled * add tests * fix tests * fix lint * remove unneeded env variable and move to constants * Pass in rootStore to fetchMetrics in order to get token in fetch.
- Loading branch information
1 parent
78267bf
commit e571ade
Showing
20 changed files
with
517 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,3 @@ | ||
GOOGLE_APPLICATION_CREDENTIALS={PATH_TO_CREDENTIALS_FILE} | ||
METRIC_BUCKET={GCS_BUCKET_NAME} | ||
AUTH_ENABLED={AUTH_ENABLED} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,155 @@ | ||
// Recidiviz - a data platform for criminal justice reform | ||
// Copyright (C) 2020 Recidiviz, Inc. | ||
// | ||
// This program is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
// | ||
// This program is distributed in the hope that it will be useful, | ||
// but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
// GNU General Public License for more details. | ||
// | ||
// You should have received a copy of the GNU General Public License | ||
// along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
// ============================================================================= | ||
|
||
const { fetchMetricsByName } = require("../core/metricsApi"); | ||
const { AUTH0_APP_METADATA_KEY } = require("../utils/constants"); | ||
const { metricsByName } = require("./api"); | ||
|
||
jest.mock("../core/metricsApi"); | ||
|
||
// mocking the node env is esoteric, see https://stackoverflow.com/a/48042799 | ||
const ORIGINAL_ENV = process.env; | ||
|
||
beforeEach(() => { | ||
fetchMetricsByName.mockImplementation( | ||
(tenantId, metrics, isDemoMode, responder) => { | ||
responder(undefined, "passed"); | ||
} | ||
); | ||
}); | ||
|
||
afterEach(() => { | ||
process.env = ORIGINAL_ENV; | ||
}); | ||
|
||
test("retrieves metrics if auth is disabled", async () => { | ||
process.env.AUTH_ENABLED = "false"; | ||
const mockFn = jest.fn(); | ||
metricsByName( | ||
{ | ||
params: { | ||
tenantId: "US_ND", | ||
}, | ||
body: { | ||
metrics: ["test_metric"], | ||
}, | ||
}, | ||
{ | ||
send: mockFn, | ||
} | ||
); | ||
expect(mockFn).toHaveBeenCalledWith("passed"); | ||
}); | ||
|
||
test("returns 401 if there is no metrics array in the request body", async () => { | ||
process.env.AUTH_ENABLED = "false"; | ||
const mockSendFn = jest.fn(); | ||
const mockStatusFn = jest.fn(); | ||
metricsByName( | ||
{ | ||
params: { | ||
tenantId: "US_ND", | ||
}, | ||
body: {}, | ||
}, | ||
{ | ||
status: () => ({ json: mockStatusFn }), | ||
send: mockSendFn, | ||
} | ||
); | ||
expect(mockSendFn).not.toHaveBeenCalled(); | ||
expect(mockStatusFn).toHaveBeenCalledWith({ | ||
error: "request is missing metrics array parameter", | ||
}); | ||
}); | ||
|
||
test("retrieves metrics if auth is enabled and user state code is 'recidiviz'", async () => { | ||
process.env.AUTH_ENABLED = "true"; | ||
const mockFn = jest.fn(); | ||
metricsByName( | ||
{ | ||
params: { | ||
tenantId: "US_ND", | ||
}, | ||
body: { | ||
metrics: ["test_metric"], | ||
}, | ||
user: { | ||
[AUTH0_APP_METADATA_KEY]: { | ||
state_code: "recidiviz", | ||
}, | ||
}, | ||
}, | ||
{ | ||
send: mockFn, | ||
} | ||
); | ||
expect(mockFn).toHaveBeenCalledWith("passed"); | ||
}); | ||
|
||
test("retrieves metrics if auth is enabled and user state code matches the request param", async () => { | ||
process.env.AUTH_ENABLED = "true"; | ||
const mockFn = jest.fn(); | ||
metricsByName( | ||
{ | ||
params: { | ||
tenantId: "US_ND", | ||
}, | ||
body: { | ||
metrics: ["test_metric"], | ||
}, | ||
user: { | ||
[AUTH0_APP_METADATA_KEY]: { | ||
state_code: "us_nd", | ||
}, | ||
}, | ||
}, | ||
{ | ||
send: mockFn, | ||
} | ||
); | ||
expect(mockFn).toHaveBeenCalledWith("passed"); | ||
}); | ||
|
||
test("returns 401 if auth is enabled and user state code doesn't match the request param", async () => { | ||
process.env.AUTH_ENABLED = "true"; | ||
const mockStatusFn = jest.fn(); | ||
const mockSendFn = jest.fn(); | ||
metricsByName( | ||
{ | ||
params: { | ||
tenantId: "US_PA", | ||
}, | ||
body: { | ||
metrics: ["test_metric"], | ||
}, | ||
user: { | ||
[AUTH0_APP_METADATA_KEY]: { | ||
state_code: "us_nd", | ||
}, | ||
}, | ||
}, | ||
{ | ||
status: () => ({ json: mockStatusFn }), | ||
send: mockSendFn, | ||
} | ||
); | ||
expect(mockSendFn).not.toHaveBeenCalled(); | ||
expect(mockStatusFn).toHaveBeenCalledWith({ | ||
error: "User is not a member of the requested tenant US_PA", | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
const AUTH0_APP_METADATA_KEY = "https://recidiviz.org/app_metadata"; | ||
|
||
module.exports = { | ||
AUTH0_APP_METADATA_KEY, | ||
}; |
Oops, something went wrong.