-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
56c51b0
commit 4597dc5
Showing
16 changed files
with
907 additions
and
6 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
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
57 changes: 57 additions & 0 deletions
57
tensorboard/webapp/metrics/data_source/card_interactions_data_source.ts
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,57 @@ | ||
/* Copyright 2023 The TensorFlow Authors. All Rights Reserved. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
==============================================================================*/ | ||
import {Injectable} from '@angular/core'; | ||
import {CardInteractions} from '../store/metrics_types'; | ||
|
||
const CARD_INTERACTIONS_KEY = 'tb-card-interactions'; | ||
|
||
const MAX_RECORDS: Record<keyof CardInteractions, number> = { | ||
pins: 10, | ||
clicks: 10, | ||
tagFilters: 10, | ||
}; | ||
|
||
@Injectable() | ||
export class CardInteractionsDataSource { | ||
saveCardInteractions(cardInteractions: CardInteractions) { | ||
const trimmedInteractions: CardInteractions = { | ||
pins: cardInteractions.pins.slice( | ||
cardInteractions.pins.length - MAX_RECORDS.pins | ||
), | ||
clicks: cardInteractions.clicks.slice( | ||
cardInteractions.clicks.length - MAX_RECORDS.clicks | ||
), | ||
tagFilters: cardInteractions.tagFilters.slice( | ||
cardInteractions.tagFilters.length - MAX_RECORDS.tagFilters | ||
), | ||
}; | ||
localStorage.setItem( | ||
CARD_INTERACTIONS_KEY, | ||
JSON.stringify(trimmedInteractions) | ||
); | ||
} | ||
|
||
getCardInteractions(): CardInteractions { | ||
const existingInteractions = localStorage.getItem(CARD_INTERACTIONS_KEY); | ||
if (existingInteractions) { | ||
return JSON.parse(existingInteractions) as CardInteractions; | ||
} | ||
return { | ||
tagFilters: [], | ||
pins: [], | ||
clicks: [], | ||
}; | ||
} | ||
} |
22 changes: 22 additions & 0 deletions
22
tensorboard/webapp/metrics/data_source/card_interactions_data_source_module.ts
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,22 @@ | ||
/* Copyright 2023 The TensorFlow Authors. All Rights Reserved. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
==============================================================================*/ | ||
import {NgModule} from '@angular/core'; | ||
import {CardInteractionsDataSource} from './card_interactions_data_source'; | ||
|
||
@NgModule({ | ||
imports: [], | ||
providers: [CardInteractionsDataSource], | ||
}) | ||
export class MetricsCardInteractionsDataSourceModule {} |
125 changes: 125 additions & 0 deletions
125
tensorboard/webapp/metrics/data_source/card_interactions_data_source_test.ts
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,125 @@ | ||
/* Copyright 2023 The TensorFlow Authors. All Rights Reserved. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
==============================================================================*/ | ||
import {TestBed} from '@angular/core/testing'; | ||
import {CardInteractionsDataSource} from './card_interactions_data_source'; | ||
import {PluginType} from '../internal_types'; | ||
|
||
describe('CardInteractionsDataSource Test', () => { | ||
let mockStorage: Record<string, string>; | ||
let dataSource: CardInteractionsDataSource; | ||
|
||
beforeEach(async () => { | ||
await TestBed.configureTestingModule({ | ||
providers: [CardInteractionsDataSource], | ||
}); | ||
|
||
dataSource = TestBed.inject(CardInteractionsDataSource); | ||
|
||
mockStorage = {}; | ||
spyOn(window.localStorage, 'setItem').and.callFake( | ||
(key: string, value: string) => { | ||
if (key !== 'tb-card-interactions') { | ||
throw new Error('incorrect key used'); | ||
} | ||
|
||
mockStorage[key] = value; | ||
} | ||
); | ||
|
||
spyOn(window.localStorage, 'getItem').and.callFake((key: string) => { | ||
if (key !== 'tb-card-interactions') { | ||
throw new Error('incorrect key used'); | ||
} | ||
|
||
return mockStorage[key]; | ||
}); | ||
}); | ||
|
||
describe('saveCardInteractions', () => { | ||
it('only saves 10 pins', () => { | ||
dataSource.saveCardInteractions({ | ||
clicks: [], | ||
tagFilters: [], | ||
pins: Array.from({length: 12}).map((_, index) => ({ | ||
cardId: `card-${index}`, | ||
runId: null, | ||
tag: 'foo', | ||
plugin: PluginType.SCALARS, | ||
})), | ||
}); | ||
|
||
expect(dataSource.getCardInteractions().pins.length).toEqual(10); | ||
}); | ||
|
||
it('only saves 10 clicks', () => { | ||
dataSource.saveCardInteractions({ | ||
pins: [], | ||
tagFilters: [], | ||
clicks: Array.from({length: 12}).map((_, index) => ({ | ||
cardId: `card-${index}`, | ||
runId: null, | ||
tag: 'foo', | ||
plugin: PluginType.SCALARS, | ||
})), | ||
}); | ||
|
||
expect(dataSource.getCardInteractions().clicks.length).toEqual(10); | ||
}); | ||
|
||
it('only saves 10 tagFilgers', () => { | ||
dataSource.saveCardInteractions({ | ||
clicks: [], | ||
tagFilters: Array.from({length: 12}).map((_, index) => | ||
index.toString() | ||
), | ||
pins: [], | ||
}); | ||
|
||
expect(dataSource.getCardInteractions().tagFilters.length).toEqual(10); | ||
}); | ||
}); | ||
|
||
describe('getCardInteractions', () => { | ||
it('returns all default state when key is not set', () => { | ||
expect(dataSource.getCardInteractions()).toEqual({ | ||
tagFilters: [], | ||
pins: [], | ||
clicks: [], | ||
}); | ||
}); | ||
|
||
it('returns previously written value', () => { | ||
dataSource.saveCardInteractions({ | ||
tagFilters: ['foo'], | ||
clicks: [ | ||
{cardId: '1', runId: null, tag: 'foo', plugin: PluginType.SCALARS}, | ||
], | ||
pins: [ | ||
{cardId: '2', runId: null, tag: 'bar', plugin: PluginType.SCALARS}, | ||
], | ||
}); | ||
|
||
expect(dataSource.getCardInteractions()).toEqual({ | ||
tagFilters: ['foo'], | ||
clicks: [ | ||
{cardId: '1', runId: null, tag: 'foo', plugin: PluginType.SCALARS}, | ||
], | ||
pins: [ | ||
{cardId: '2', runId: null, tag: 'bar', plugin: PluginType.SCALARS}, | ||
], | ||
}); | ||
}); | ||
}); | ||
}); |
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
Oops, something went wrong.