Skip to content

ref: Enable noUncheckedIndexedAccess TS config #12461

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -896,15 +896,15 @@ jobs:

- name: Overwrite typescript version
if: matrix.typescript
run: yarn add --dev --ignore-workspace-root-check typescript@${{ matrix.typescript }}
run: node ./scripts/use-ts-version.js ${{ matrix.typescript }}
working-directory: dev-packages/node-integration-tests

- name: Run integration tests
env:
NODE_VERSION: ${{ matrix.node }}
TS_VERSION: ${{ matrix.typescript }}
run: |
cd dev-packages/node-integration-tests
yarn test
working-directory: dev-packages/node-integration-tests
run: yarn test

job_remix_integration_tests:
name: Remix v${{ matrix.remix }} (Node ${{ matrix.node }}) Tests
Expand Down
23 changes: 23 additions & 0 deletions dev-packages/node-integration-tests/scripts/use-ts-version.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
/* eslint-disable no-console */
const { execSync } = require('child_process');
const { join } = require('path');
const { writeFileSync } = require('fs');

const cwd = join(__dirname, '../../..');

const tsVersion = process.argv[2] || '3.8';

console.log(`Installing typescript@${tsVersion}...`);

execSync(`yarn add --dev --ignore-workspace-root-check typescript@${tsVersion}`, { stdio: 'inherit', cwd });

console.log('Removing unsupported tsconfig options...');

const baseTscConfigPath = join(cwd, 'packages/typescript/tsconfig.json');

const tsConfig = require(baseTscConfigPath);

// TS 3.8 fails build when it encounteres a config option it does not understand, so we remove it :(
delete tsConfig.compilerOptions.noUncheckedIndexedAccess;

writeFileSync(baseTscConfigPath, JSON.stringify(tsConfig, null, 2));
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ afterAll(() => {
conditionalTest({ min: 16 })('complex-router', () => {
test('should construct correct url with multiple parameterized routers, when param is also contain in middle layer route and express used multiple middlewares with route', done => {
// parse node.js major version
const [major] = process.versions.node.split('.').map(Number);
const [major = 0] = process.versions.node.split('.').map(Number);
// Split test result base on major node version because regex d flag is support from node 16+

const EXPECTED_TRANSACTION =
Expand All @@ -36,7 +36,7 @@ conditionalTest({ min: 16 })('complex-router', () => {

test('should construct correct url with multiple parameterized routers, when param is also contain in middle layer route and express used multiple middlewares with route and original url has query params', done => {
// parse node.js major version
const [major] = process.versions.node.split('.').map(Number);
const [major = 0] = process.versions.node.split('.').map(Number);
// Split test result base on major node version because regex d flag is support from node 16+
const EXPECTED_TRANSACTION =
major >= 16
Expand All @@ -62,7 +62,7 @@ conditionalTest({ min: 16 })('complex-router', () => {

test('should construct correct url with multiple parameterized routers, when param is also contain in middle layer route and express used multiple middlewares with route and original url ends with trailing slash and has query params', done => {
// parse node.js major version
const [major] = process.versions.node.split('.').map(Number);
const [major = 0] = process.versions.node.split('.').map(Number);
// Split test result base on major node version because regex d flag is support from node 16+
const EXPECTED_TRANSACTION =
major >= 16
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ afterAll(() => {
conditionalTest({ min: 16 })('middle-layer-parameterized', () => {
test('should construct correct url with multiple parameterized routers, when param is also contain in middle layer route', done => {
// parse node.js major version
const [major] = process.versions.node.split('.').map(Number);
const [major = 0] = process.versions.node.split('.').map(Number);
// Split test result base on major node version because regex d flag is support from node 16+
const EXPECTED_TRANSACTION =
major >= 16
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ conditionalTest({ min: 18 })('LocalVariables integration', () => {
.ignore('session')
.expect({
event: event => {
for (const frame of event.exception?.values?.[0].stacktrace?.frames || []) {
for (const frame of event.exception?.values?.[0]?.stacktrace?.frames || []) {
expect(frame.vars).toBeUndefined();
}
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ test('should report finished spans as children of the root transaction.', done =
.expect({
transaction: transaction => {
const rootSpanId = transaction.contexts?.trace?.span_id;
const span3Id = transaction.spans?.[1].span_id;
const span3Id = transaction.spans?.[1]?.span_id;

expect(rootSpanId).toEqual(expect.any(String));
expect(span3Id).toEqual(expect.any(String));
Expand Down
3 changes: 3 additions & 0 deletions dev-packages/node-integration-tests/suites/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "../tsconfig.test.json",
}
12 changes: 9 additions & 3 deletions dev-packages/node-integration-tests/utils/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,13 @@ export class TestEnv {
* @returns The extracted envelope.
*/
public async getEnvelopeRequest(options?: DataCollectorOptions): Promise<Array<Record<string, unknown>>> {
return (await this.getMultipleEnvelopeRequest({ ...options, count: 1 }))[0];
const requests = await this.getMultipleEnvelopeRequest({ ...options, count: 1 });

if (!requests[0]) {
throw new Error('No requests found');
}

return requests[0];
}

/**
Expand Down Expand Up @@ -239,7 +245,7 @@ export class TestEnv {
.post('/api/1337/envelope/', body => {
const envelope = parseEnvelope(body);

if (envelopeType.includes(envelope[1].type as EnvelopeItemType)) {
if (envelopeType.includes(envelope[1]?.type as EnvelopeItemType)) {
envelopes.push(envelope);
} else {
return false;
Expand Down Expand Up @@ -296,7 +302,7 @@ export class TestEnv {
.post('/api/1337/envelope/', body => {
const envelope = parseEnvelope(body);

if (options.envelopeType.includes(envelope[1].type as EnvelopeItemType)) {
if (options.envelopeType.includes(envelope[1]?.type as EnvelopeItemType)) {
reqCount++;
return true;
}
Expand Down
21 changes: 9 additions & 12 deletions dev-packages/overhead-metrics/src/util/github.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const octokit = new Octokit({
// log: console,
});

const [, owner, repo] = (await Git.repository).split('/');
const [, owner, repo] = (await Git.repository).split('/') as [string, string, string];
const defaultArgs = { owner, repo };

async function downloadArtifact(url: string, path: string): Promise<void> {
Expand Down Expand Up @@ -51,15 +51,10 @@ async function tryAddOrUpdateComment(commentBuilder: PrCommentBuilder): Promise<
For example, refs/heads/feature-branch-1.
*/
let prNumber: number | undefined;
if (
typeof process.env.GITHUB_REF == 'string' &&
process.env.GITHUB_REF.length > 0 &&
process.env.GITHUB_REF.startsWith('refs/pull/')
) {
prNumber = parseInt(process.env.GITHUB_REF.split('/')[2]);
console.log(
`Determined PR number ${prNumber} based on GITHUB_REF environment variable: '${process.env.GITHUB_REF}'`,
);
const githubRef = process.env.GITHUB_REF;
if (typeof githubRef == 'string' && githubRef.length > 0 && githubRef.startsWith('refs/pull/')) {
prNumber = parseInt(githubRef.split('/')[2] as string);
console.log(`Determined PR number ${prNumber} based on GITHUB_REF environment variable: '${githubRef}'`);
} else if (!(await Git.branchIsBase)) {
prNumber = (
await octokit.rest.pulls.list({
Expand Down Expand Up @@ -155,15 +150,17 @@ export const GitHub = {
status: 'success',
});

if (workflowRuns.data.total_count == 0) {
const firstRun = workflowRuns.data.workflow_runs[0];

if (workflowRuns.data.total_count == 0 || !firstRun) {
console.warn(`Couldn't find any successful run for workflow '${workflow.name}'`);
return;
}

const artifact = (
await octokit.actions.listWorkflowRunArtifacts({
...defaultArgs,
run_id: workflowRuns.data.workflow_runs[0].id,
run_id: firstRun.id,
})
).data.artifacts.find(it => it.name == artifactName);

Expand Down
2 changes: 1 addition & 1 deletion dev-packages/test-utils/src/event-proxy-server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ export async function startEventProxyServer(options: EventProxyServerOptions): P
? zlib.gunzipSync(Buffer.concat(proxyRequestChunks)).toString()
: Buffer.concat(proxyRequestChunks).toString();

const envelopeHeader: EnvelopeItem[0] = JSON.parse(proxyRequestBody.split('\n')[0]);
const envelopeHeader: EnvelopeItem[0] = JSON.parse(proxyRequestBody.split('\n')[0] as string);

const shouldForwardEventToSentry = options.forwardToSentry != null ? options.forwardToSentry : true;

Expand Down
2 changes: 1 addition & 1 deletion packages/aws-serverless/src/sdk.ts
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ export function tryPatchHandler(taskRoot: string, handlerPath: string): void {
return;
}

const [, handlerMod, handlerName] = match;
const [, handlerMod = '', handlerName = ''] = match;

let obj: HandlerBag;
try {
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-serverless/test/sdk.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -502,7 +502,7 @@ describe('AWSLambda', () => {

expect(evtProcessor).toBeInstanceOf(Function);
// @ts-expect-error just mocking around...
expect(evtProcessor(event).exception.values[0].mechanism).toEqual({
expect(evtProcessor(event).exception.values[0]?.mechanism).toEqual({
handled: false,
type: 'generic',
});
Expand Down
11 changes: 6 additions & 5 deletions packages/browser-utils/src/metrics/browserMetrics.ts
Original file line number Diff line number Diff line change
Expand Up @@ -282,21 +282,22 @@ export function addPerformanceEntries(span: Span): void {
_addTtfbRequestTimeToMeasurements(_measurements);

['fcp', 'fp', 'lcp'].forEach(name => {
if (!_measurements[name] || !transactionStartTime || timeOrigin >= transactionStartTime) {
const measurement = _measurements[name];
if (!measurement || !transactionStartTime || timeOrigin >= transactionStartTime) {
return;
}
// The web vitals, fcp, fp, lcp, and ttfb, all measure relative to timeOrigin.
// Unfortunately, timeOrigin is not captured within the span span data, so these web vitals will need
// to be adjusted to be relative to span.startTimestamp.
const oldValue = _measurements[name].value;
const oldValue = measurement.value;
const measurementTimestamp = timeOrigin + msToSec(oldValue);

// normalizedValue should be in milliseconds
const normalizedValue = Math.abs((measurementTimestamp - transactionStartTime) * 1000);
const delta = normalizedValue - oldValue;

DEBUG_BUILD && logger.log(`[Measurements] Normalized ${name} from ${oldValue} to ${normalizedValue} (${delta})`);
_measurements[name].value = normalizedValue;
measurement.value = normalizedValue;
});

const fidMark = _measurements['mark.fid'];
Expand All @@ -320,8 +321,8 @@ export function addPerformanceEntries(span: Span): void {
delete _measurements.cls;
}

Object.keys(_measurements).forEach(measurementName => {
setMeasurement(measurementName, _measurements[measurementName].value, _measurements[measurementName].unit);
Object.entries(_measurements).forEach(([measurementName, measurement]) => {
setMeasurement(measurementName, measurement.value, measurement.unit);
});

_tagMetricInfo(span);
Expand Down
2 changes: 2 additions & 0 deletions packages/browser-utils/src/metrics/web-vitals/getCLS.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ export const onCLS = (onReport: CLSReportCallback, opts: ReportOpts = {}): void
// session.
if (
sessionValue &&
firstSessionEntry &&
lastSessionEntry &&
entry.startTime - lastSessionEntry.startTime < 1000 &&
entry.startTime - firstSessionEntry.startTime < 5000
) {
Expand Down
2 changes: 1 addition & 1 deletion packages/browser-utils/src/metrics/web-vitals/getINP.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ const processEntry = (entry: PerformanceEventTiming) => {
if (
existingInteraction ||
longestInteractionList.length < MAX_INTERACTIONS_TO_CONSIDER ||
entry.duration > minLongestInteraction.latency
(minLongestInteraction && entry.duration > minLongestInteraction.latency)
) {
// If the interaction already exists, update it. Otherwise create one.
if (existingInteraction) {
Expand Down
8 changes: 4 additions & 4 deletions packages/browser-utils/test/browser/browserMetrics.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ describe('_addResourceSpans', () => {
},
];
for (let i = 0; i < table.length; i++) {
const { initiatorType, op } = table[i];
const { initiatorType, op } = table[i]!;
const entry: ResourceEntry = {
initiatorType,
};
Expand Down Expand Up @@ -250,7 +250,7 @@ describe('_addResourceSpans', () => {
_addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);

expect(spans).toHaveLength(1);
expect(spanToJSON(spans[0])).toEqual(
expect(spanToJSON(spans[0]!)).toEqual(
expect.objectContaining({
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'resource.css',
Expand Down Expand Up @@ -284,7 +284,7 @@ describe('_addResourceSpans', () => {
_addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);

expect(spans).toHaveLength(1);
expect(spanToJSON(spans[0])).toEqual(
expect(spanToJSON(spans[0]!)).toEqual(
expect.objectContaining({
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'resource.css',
Expand Down Expand Up @@ -321,7 +321,7 @@ describe('_addResourceSpans', () => {
_addResourceSpans(span, entry, resourceEntryName, 100, 23, 345);

expect(spans).toHaveLength(1);
expect(spanToJSON(spans[0])).toEqual(
expect(spanToJSON(spans[0]!)).toEqual(
expect.objectContaining({
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'resource.css',
Expand Down
3 changes: 2 additions & 1 deletion packages/browser/src/eventbuilder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,8 @@ function eventFromPlainObject(
const frames = parseStackFrames(stackParser, syntheticException);
if (frames.length) {
// event.exception.values[0] has been set above
event.exception.values[0].stacktrace = { frames };
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
event.exception.values[0]!.stacktrace = { frames };
}
}

Expand Down
52 changes: 28 additions & 24 deletions packages/browser/src/integrations/httpclient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,28 +77,8 @@ function _fetchResponseHandler(
let requestHeaders, responseHeaders, requestCookies, responseCookies;

if (_shouldSendDefaultPii()) {
[{ headers: requestHeaders, cookies: requestCookies }, { headers: responseHeaders, cookies: responseCookies }] = [
{ cookieHeader: 'Cookie', obj: request },
{ cookieHeader: 'Set-Cookie', obj: response },
].map(({ cookieHeader, obj }) => {
const headers = _extractFetchHeaders(obj.headers);
let cookies;

try {
const cookieString = headers[cookieHeader] || headers[cookieHeader.toLowerCase()] || undefined;

if (cookieString) {
cookies = _parseCookieString(cookieString);
}
} catch (e) {
DEBUG_BUILD && logger.log(`Could not extract cookies from header ${cookieHeader}`);
}

return {
headers,
cookies,
};
});
[requestHeaders, requestCookies] = _parseCookieHeaders('Cookie', request);
[responseHeaders, responseCookies] = _parseCookieHeaders('Set-Cookie', response);
Comment on lines +80 to +81
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice refactor!

}

const event = _createEvent({
Expand All @@ -115,6 +95,26 @@ function _fetchResponseHandler(
}
}

function _parseCookieHeaders(
cookieHeader: string,
obj: Request | Response,
): [Record<string, string>, Record<string, string> | undefined] {
const headers = _extractFetchHeaders(obj.headers);
let cookies;

try {
const cookieString = headers[cookieHeader] || headers[cookieHeader.toLowerCase()] || undefined;

if (cookieString) {
cookies = _parseCookieString(cookieString);
}
} catch (e) {
DEBUG_BUILD && logger.log(`Could not extract cookies from header ${cookieHeader}`);
}

return [headers, cookies];
}

/**
* Interceptor function for XHR requests
*
Expand Down Expand Up @@ -192,7 +192,9 @@ function _getResponseSizeFromHeaders(headers?: Record<string, string>): number |
function _parseCookieString(cookieString: string): Record<string, string> {
return cookieString.split('; ').reduce((acc: Record<string, string>, cookie: string) => {
const [key, value] = cookie.split('=');
acc[key] = value;
if (key && value) {
acc[key] = value;
}
return acc;
}, {});
}
Expand Down Expand Up @@ -228,7 +230,9 @@ function _getXHRResponseHeaders(xhr: XMLHttpRequest): Record<string, string> {

return headers.split('\r\n').reduce((acc: Record<string, string>, line: string) => {
const [key, value] = line.split(': ');
acc[key] = value;
if (key && value) {
acc[key] = value;
}
return acc;
}, {});
}
Expand Down
Loading
Loading