Adding options to disable certain API per media type #133

ltctceplrm · 2024-01-30T16:18:55Z

The code is currently not yet functional because I don't know how to get the MediaType so I can add it to the API name. To test if the rest of the code works I modified this line

const apiSettings = [api.apiName, MediaTypeModel].filter(s => s).join('') as keyof typeof this.plugin.settings;

const apiSettings = [api.apiName, "game"].filter(s => s).join('') as keyof typeof this.plugin.settings;

And it correctly filters out the APIs that are not checked. Same works for movies or series.

@mProjectsCode is there a way to get the media type after it calls APIManager?

Currently only has the plugin settings and they don't do anything yet

…-db-plugin

I'm close but I don't now how to get the MediaType that the plugin called

ltctceplrm · 2024-02-01T17:37:25Z

I've added a mediaType variable that gets sent with the search query so adding media by media type is currently functional.
I still need to fix the advanced APIsearch since that one is broken API's that you can turn off, I think I went wrong somewhere with the API = default check

mProjectsCode · 2024-02-01T17:56:55Z

src/settings/Settings.ts

 	openNoteInNewTab: boolean;
 	useDefaultFrontMatter: boolean;
 	enableTemplaterIntegration: boolean;
+	OMDbAPImovie: boolean;


I would organize them into sub-objects, by media type.

This should also make the code for figuring out which APIs to use simpler.

mProjectsCode · 2024-02-01T17:57:41Z

src/settings/Settings.ts

 				});
 			});

+


It would be better if these settings were automatically generated. That would mean less maintenance work.

I agree but don't know how to do so yet, especially because it's only for certain APIs

Ok, if you don't know how to do that, then I will rewrite this after merging.

src/settings/Settings.ts

mProjectsCode · 2024-02-01T18:05:24Z

src/api/APIManager.ts

 	 * @param apisToQuery
 	 */
-	async query(query: string, apisToQuery: string[]): Promise<MediaTypeModel[]> {
+	async query(query: string, apisToQuery: string[], mediaType: string): Promise<MediaTypeModel[]> {


It would probably be better if you did the filtering of which APIs to query (based on the user's settings) before calling this method and leave the method as it was.

src/api/apis/MALAPIManga.ts

ltctceplrm · 2024-02-01T18:54:16Z

@mProjectsCode I found the mistake I mentioned and simplified the code by removing the whole "default" API setting, now Advanced Search and Media Type Search both work correctly! I'm looking through your notes now and seeing what I need to change

For MAL, MusicBrainz and Wikipedia

ltctceplrm · 2024-02-06T01:42:22Z

I reverted changes to main.ts so the this.apiManager.query method is left alone and instead modified hasType in APIModel.ts to check whether the API is turned on or not for the media type.

I've tested it out and it correctly skips the disabled APIs when selecting only 1 media type, however if you select multiple media types (movies and games) where the same API (omdb) has been turned off for one media type (movies) but not for another media type (games) then it will still return movies as well as games for omdb. I'm not sure if this is wanted/intentional or not.

ltctceplrm · 2024-02-06T02:20:14Z

Seeing as the plugin is simultaneously searching for games and movies I don't see how it would be possible to exclude just the games returned by omdb without really overcomplicating the code. Unless I'm missing an easy solution I'd suggest maybe only being able to toggle one media type at a time and if you toggle a second one it un-toggles the previous one?

ltctceplrm · 2024-02-06T20:11:01Z

I pushed too soon, there's still a mistake in my toggle thingy

ltctceplrm · 2024-02-06T20:25:51Z

Okay it's fixed now

ltctceplrm · 2024-02-22T12:47:16Z

Please let me know if I should change anything else or if it's good like this

mProjectsCode · 2024-03-01T18:39:28Z

I am currently quite busy, I will review this maybe next week.

ltctceplrm · 2024-03-06T22:31:01Z

That's okay, please take your time. Thank you for looking into it.

src/api/APIManager.ts

mProjectsCode · 2024-03-16T10:30:15Z

src/api/APIModel.ts


 	hasType(type: MediaType): boolean {
-		return this.types.contains(type);
+		if (this.types.contains(type) && !(this.plugin.settings[[this.apiName, type].filter(s => s).join('') as keyof typeof this.plugin.settings] === false)){


[this.apiName, type].filter(s => s).join('') as keyof typeof this.plugin.settings

Why not do (this.apiName + type) as keyof MediaDbPluginSettings?

However, I would still recommend organizing the settings into sub-objects for each api.

src/modals/MediaDbSearchModal.ts

mProjectsCode · 2024-03-16T10:37:32Z

src/modals/MediaDbSearchModal.ts

+			}
 			apiToggleComponent.onChange(value => {
-				this.selectedTypes.find(x => x.name === mediaType).selected = value;
+				if (value) {


What exactly is this code doing? Are you forcing the value of the toggle to be off in certain conditions? If so there is a better way to disable the toggle component. See the setDisabled(value) prop of the toggle component.

mProjectsCode · 2024-03-16T10:41:47Z

src/settings/Settings.ts

 				});
 			});

+


Ok, if you don't know how to do that, then I will rewrite this after merging.

ltctceplrm · 2024-03-16T13:09:12Z

Thank you for looking over the code. I'm going to address some of the problems right now and the other ones I'll probably get to tomorrow.

ltctceplrm · 2024-03-24T16:46:43Z

Hello @mProjectsCode, I finally succeeded turning the API toggles into sub objects like you asked, the code additions are once again fully functional (at least according to my tests). I believe I have finished with this pull request but please let me know if I forgot something

mProjectsCode · 2024-04-11T19:11:49Z

I will just merge this and then make some changes myself

ltctceplrm · 2024-04-14T00:37:46Z

That's great, thank you merging and also fixing up the code.

ltctceplrm added 9 commits January 27, 2024 22:39

Added settings for disabling certain APIs (WIP)

c20e89e

Currently only has the plugin settings and they don't do anything yet

Merge branch 'master' of https://github.com/ltctceplrm/obsidian-media…

ca7658b

…-db-plugin

WIP api selection

436f98c

I'm close but I don't now how to get the MediaType that the plugin called

Reverted accidental newline in main.ts

867bfec

Normalized the apiName fields

2ea2378

Added temporary way to test media type as "game"

d1affcd

Fixed advanced search by adding a default media type for certain APIs

508b0ed

Made sure to always allow default APIs

5a8feca

Added media type passed along with the apis to query and the title

0157c0a

mProjectsCode reviewed Feb 1, 2024

View reviewed changes

Removed "default" setting and only check if media type is false or not

675a0f7

ltctceplrm added 2 commits February 1, 2024 20:05

Reverted the api names

54766bb

For MAL, MusicBrainz and Wikipedia

Second attempt to selectively turn off APIs

5b35e55

Removed unneccessary stringifying

0634e39

Modified the toggles so only one can be on at a time

c5ba44c

ltctceplrm marked this pull request as ready for review February 6, 2024 19:47

ltctceplrm changed the title ~~WIP: Adding options to disable certain API per media type~~ Adding options to disable certain API per media type Feb 6, 2024

Fixed oversight in toggle code

f520604

ltctceplrm requested a review from mProjectsCode February 22, 2024 12:46

mProjectsCode reviewed Mar 16, 2024

View reviewed changes

ltctceplrm added 4 commits March 16, 2024 14:18

Ran formatter, removed unused array and updated APIModel.ts

5eec98d

Added sub-objects for api toggles (WIP)

31ffd0d

Ran formatter

139cf83

Fixed the WIP sub object code

9bc3bea

mProjectsCode merged commit cf3d5c6 into mProjectsCode:master Apr 11, 2024

ZackBoe mentioned this pull request Jun 3, 2024

Steam: use Steam Community SearchApps for title search #146

Merged

ltctceplrm mentioned this pull request Aug 21, 2024

Videogames nolonger searchable #159

Closed

3 tasks

Adding options to disable certain API per media type #133

Adding options to disable certain API per media type #133

Uh oh!

Conversation

ltctceplrm commented Jan 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ltctceplrm commented Feb 1, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ltctceplrm commented Feb 1, 2024

Uh oh!

ltctceplrm commented Feb 6, 2024

Uh oh!

ltctceplrm commented Feb 6, 2024

Uh oh!

ltctceplrm commented Feb 6, 2024

Uh oh!

ltctceplrm commented Feb 6, 2024

Uh oh!

ltctceplrm commented Feb 22, 2024

Uh oh!

mProjectsCode commented Mar 1, 2024

Uh oh!

ltctceplrm commented Mar 6, 2024

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ltctceplrm commented Mar 16, 2024

Uh oh!

ltctceplrm commented Mar 24, 2024

Uh oh!

mProjectsCode commented Apr 11, 2024

Uh oh!

ltctceplrm commented Apr 14, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ltctceplrm commented Jan 30, 2024 •

edited

Loading